home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 2 / United Public Domain Gold 2.iso / utilities / pu643.dms / pu643.adf / SS / README next >
Text File  |  1990-08-20  |  20KB  |  459 lines
  1. Silicon Secretary V1.1  August 20, 1990
  2. Allen Maroney
  3. 2009-66th Ave. S.
  4. St. Petersburg, FL 33712  (USA)
  5. SHAREWARE - $25
  6.  
  7. If you can't afford the shareware fee please send me a card so that I can
  8. keep track of how far SS has traveled.
  9.  
  10. Suggestions and comments, as always, are welcome. (except Peterson Point!)
  11. Contact me through GEnie Mail (A.MARONEY) or Snail Mail.
  12.  
  13. The following files should be in this archive:
  14. (All files ending with 'HELP' should go in a subdirectory named 'HELP')
  15.  
  16. The ARC should include:
  17.     SS      <-- The main program
  18.     SS.info    <-- graphical representation of my efforts 
  19.                     This is similar to the efforts of a movie critic
  20.                     who spends 4-6 years in college, 2 years as a 
  21.                     'cub reporter' and 5 hours watching and evaluating
  22.                     a movie just to have three stars printed next to the
  23.                     movie's title.  Sigh.
  24.         TestData        <-- An example league*
  25.         TestData.info   <-- The icon for TestData*
  26.     README          <-- You're readin' it now
  27.         Help.info       <-- An icon for the Help directory
  28.     SS.HELP        -|  Place these in a subdirectory named 'HELP'
  29.     SS.LEAGUEHELP     |  They're not really even started but the
  30.     SS.PERSONALHELP     |- main program uses them if you press HELP
  31.     SS.TEAM.HELP     |  LHARC v1.10 (or -x FLAG) will create and place
  32.         SS.OUTPUTHELP   -|  them in a directory named HELP automatically.
  33.                             
  34.                             * Not included in archives to beta testers
  35.  
  36.  If you have a previous version please remember to update your help files.
  37.  
  38.  =============================================================================
  39.   WHAT IS IT?
  40.  
  41.   * For starters, it's BIG, about 350K.  (I have been told that
  42.     bigger is better.)
  43.  
  44.   * It can do in 20 seconds what a league secretary might be able to do in
  45.     a few hours by hand.
  46.  
  47.   * It cost nothing to try out.  If you use it I ask $25 in return for all
  48.     of the time that SS will save for you.
  49.  
  50.   * If you were able to download this file and unlharc it you should have
  51.     no problems learning how the Silicon Secretary works.
  52.  
  53.  
  54.   LET'S BE MORE SPECIFIC, OKAY?
  55.  
  56.   You build a league data base containing teams, bowlers and subs.  Each
  57.   week you enter each bowler's scores and the team's win/loss record and
  58.   'RUN' this new data through the program.  In return for this effory on
  59.   your part you're rewarded with a fairly complete report on teams and
  60.   bowlers.  Load the file called TestData and RUN ALL WEEKS (it's in the
  61.   menu).  If you're not COMPLETELY SATISFIED, format the disk and you owe
  62.   me nothing!
  63.  
  64.   Are there any remaining bugs?  It would be a save bet with yes. While I
  65.   spent a considerable amount of time testing and verifying things I'm sure
  66.   that something (or a few somethings) slipped through the cracks.  If
  67.   you find anything wrong let me know.
  68.  
  69.   The final output is almost a direct ripoff of a commercial system
  70.   that some of the local alleys use.  I just wanted to prove that it could
  71.   be done better on the Amiga.
  72.  
  73.   All help is accessed by clicking on the window in question and
  74.   pressing the HELP key.   Help with the menus may also be accessed by
  75.   the menu item 'HELP'.  These are pure ASCII text files that may be loaded
  76.   into and edited with most word processors.  To print any help menu click
  77.   the 'PRT' gadget to the right of the test (you need a printer also  :-)
  78.  
  79.   If anyone has a need for the format of the data file I would be willing
  80.   part with that info for a good cause.
  81.  
  82.   Silicon was written in Manx C v3.6a.  (I havn't had enough experience
  83.   with Manx v5.0 to transport it over yet)  I have no plans on changing
  84.   data file format.  But, if it should, it will be transparent to the you.
  85.  
  86.   If you have Power Packer or something like it you may want to compress
  87.   the SS file to save disk space.  Personally, I like quicker load times.
  88.  
  89.   I really want to thank a few people for inspiration, guidance and beta
  90.   testing...
  91.  
  92.       Tim Martin (arthur of SID) for some great code - especially the
  93.                  quicksort routine and exec specific stuff.
  94.                  [If you've never tried SID, check it out!]
  95.  
  96.       Jerry T. Brown - Ace beta tester and data inputer.  About half of
  97.                        the features in SS came from Jerry's ideas.
  98.  
  99.       Fabbian Dufoe - King of generic 'C' and all-around great guy.
  100.  
  101.       Jimbo Barber (arthur of StarTrek) - For NOT talking me into
  102.                    switching to Modula-2  :-)  (Bye Jimbo, sniff)
  103.  
  104.       And the rest of the Tsunami Programming SIG gang.
  105.  
  106. <<< FUTURE >>>
  107.  
  108.     - I'm considering dumping the last half Pins & Games in favor of
  109.       some sort of accounting system.  This could develop into a separate
  110.       window for league bookkeeping.  Comments are welcome on this.
  111.  
  112.  
  113. <<< HISTORY >>>
  114.  
  115. *** V1.1 (8-20-90)
  116.  
  117.     - All old (v1.0) data files will work with V1.1.
  118.  
  119.     - An icon for the Help directory is now included
  120.  
  121.     - If the Schedule is selected (under OUTPUT-OPTS. menu) the position
  122.       weeks will now be filled in correctly (1st vs 2nd, 3rd vs 4th, etc.)
  123.  
  124.     - The Most Improved Averages will now round down.  This is part of the
  125.       End Of Season (EOS) report.
  126.  
  127.     - The final week in each half will be noted as such at the top of
  128.       the pages.
  129.  
  130.     - Spruced up the command line help.  Type "SS ?" from the CLI
  131.       (without the quotes).
  132.  
  133.     - Tested and works on a 25 MHz A3000.  The testing consisted of
  134.       about 20 minutes of playing around, not exactly scientific.
  135.       Under Workbench 2.0 there was a noticable delay after each press
  136.       of the left mouse button.  With that exception everything seemed to
  137.       work the same as it does on 500/100/200, only faster.  I'll check
  138.       into the delay when WB 2.0 is released to the general public.
  139.  
  140.     - The OTHER menu has a new addition - AVG. BEEP
  141.       Some recap forms have the bowler's average next to the first
  142.       game.  It's easy to enter the average as the first game if
  143.       you're not very careful (I've done it).  If this is checked
  144.       the screen will flash (DisplayBeep) whenever a bowler's average
  145.       is entered as a score.  This is only a reminder to be careful.
  146.       Other than the flash nothing else changes.
  147.  
  148.     - The SEX (got your attention?) gadget is now a little smarter.  Whatever
  149.       your league has the most of (men or women) will be selected whenever
  150.       a new bowler is created.  Thsi way on a all woman league after the 
  151.       gadget is clicked to female [F] on the first bowler it will default to
  152.       female for all remaining bowlers.
  153.       To prvent you from clicking the SEX gadget by mistake you will be
  154.       asked to verify the change after the second week.  The logic here is
  155.       that after the second week you should know what sex they are and
  156.       will most likely not change [excluding California].
  157.  
  158.     - Bowlers named 'BLIND' or '#BLIND' do not show up on the Address or
  159.       Phone list now.
  160.  
  161.     - Some of the menus have been relocated to, what I feel anyway, is a
  162.       more logical location under OUTPUT to OPTS. (OPTIONS).  They include:
  163.       AWARDS, SCHEDULE, SHORT FORM.
  164.  
  165.     - In addition to the above moves a new option named SUB LIST has been
  166.       added.  This will display the floating subs' names, average and phone
  167.       numbers after the main printout.  This could be handy for teams that
  168.       need a bowler at the last minute.  This list will print out on a
  169.       separate page.
  170.  
  171.     - Below SUB LIST is another new creature named RECAP FORM.  It prints
  172.       recap forms using the ABC/WIBC rotation schedule.  Since it only
  173.       prints to standard paper (not carbon or NCR pre-printed forms) its
  174.       usefulness may be limited by your league's rules (If your league
  175.       requires multi-part forms)
  176.       If your League has an odd number of teams a 'team' of 'blind' bowlers
  177.       will be created using your Blind Score - 10 pins.
  178.  
  179.     - Fixed a minor bug that caused the tenth week file name to be appended
  180.       with a '0'.
  181.  
  182.     - Bowlers with exactly the QUALIFY GAMES bowled will now show up
  183.       in the end-of-season (EOS) report.
  184.  
  185.     - Bowlers must have bowled 21* games before they can qualify for
  186.       scratch or handicap season leaders.  Previous versions didn't place
  187.       restrictions on scratch series/games.
  188.  
  189.     - The RETROACTIVE HANDICAP gadget has been dumped.  It has been
  190.       replaced with a option for selecting the way that the season leaders
  191.       qualify.  This is a percentage of actual gamed bowled against
  192.       possible games.  Selecting ALL QUALIFY allows every bowler to
  193.       qualify after their first game.
  194.  
  195.     - Patch qualification is tied into the QUALIFY GAMES gadget in the 
  196.       League Info. window.  The bowler cannot qualify for a patch until
  197.       they bowl 21* games.
  198.  
  199.       *21 is the default, the actual number of games is determined by
  200.        whatever you enter in QUALIFY GAMES.
  201.  
  202.     - Other assorted minor or cosmetic changes.
  203.  
  204. *** V1.0 (6-5-90)
  205.  
  206.     - Totally re-wrote the scheduler part.  It now uses the ABC/WIBC
  207.       team schedules.  Currently leagues with between 3 and 20 teams
  208.       can take advantage of this.  I haven't added schedules beyond
  209.       20 teams, but if there are many requests I may in the future.
  210.  
  211.     - Added SCHEDULE to the OTHER menu.  If this is selected the following
  212.       week's schedule will be printed in the statistics report each week.
  213.       These are taken from the above ABC/WIBC schedule.
  214.  
  215.     - Fixed a bug that would cause some of the first games to have scores
  216.       in them when a new bowler is created.  This bug was born in V0.9.
  217.  
  218.     - Added 3-200 games to the men's awards.  This was an oversight.
  219.  
  220.     - Fixed a bug that didn't show the 'f'irst, 's'econd and 't'hird
  221.       places for the last team's high series and games.
  222.  
  223.     - Fixed a bug that allowed the astrisk for using the entering average
  224.       to remain after the it wasn't being used.
  225.  
  226.     - Fixed a bug that allowed individual patch awards to compound every
  227.       time you ran the data.  It now clears between runs.
  228.  
  229.     - Added a letter representing league offices to the end of each bowler's
  230.       name that is a officer.  (This is not part of the SHORT FORM option)
  231.       See the docs for more details.
  232.  
  233.     - Added a 'BYTES FREE' display to the team editor window's status line.
  234.       Selecting TEAM EDITOR from the menu or pressing return on most
  235.       string gadgets will display the remaining chip and fast ram.
  236.  
  237. *** V0.9
  238.     - MOST IMPROVED AVERAGES and HIGH AVERAGES will be printed at the
  239.       end of the END OF SEASON REPORT.  Both of these will be displayed
  240.       with one decimal point to help resolve ties.  Only Bowlers with
  241.       at least QUALIFY_GAMES will be displayed.
  242.       (QUALIFY_GAMES is set in the League Editor and would normally be 21)
  243.       
  244.     - Page heads now print at the top of each END OF SEASON REPORT page.
  245.  
  246.     - Floating subs may be added, deleted and transposed (moved).
  247.       All of the scores in the league will be adjusted to reflect
  248.       these change so that the correct sub is used.  There will be a
  249.       slight delay during these changed if the league is large.
  250.       NOTE: Only floating subs that are NOT being used may be deleted.
  251.  
  252.     - Fix a bug that allowed both men and women to qualify for ABC &
  253.       WIBC awards.  Now only men qualify for ABC and women for WIBC.
  254.  
  255.     - Fixed a page number glitch that caused even numbered pages to be
  256.       skipped.  (damn recursion!  :-)
  257.  
  258.     - The END OF SEASON report and AWARDS only displays bowlers that have
  259.       at least XX games.  Where XX is the nymber of games you entered in the
  260.       Qualify Games field in the League Editor, usually 21.
  261.  
  262.     - Added the LAST WEEK'S HIGHS after the individual stats in the main
  263.       (RUN) output.  NOTE: Each bowler will only be displayed ONCE in each
  264.       category, even if they place first and second.
  265.  
  266. *** V0.8
  267.     - Fixed a bug in the floating subs.  The program WAS looking at the
  268.       current floating sub's current handicap not the handicap of the
  269.       week that they were used.
  270.  
  271.     - INDIVIDUAL FORFEITURES may be entered by clicking the ABSENT gadget
  272.       on a bowler with a score in the current week.  Clicking again or
  273.       manually entering on that score will turn it off.  This is fairly
  274.       complicated so read the instructions! 
  275.  
  276.     - The League Editor option 'USE EA AVERAGE THROUGH WEEK:' has been
  277.       changed to 'USE EA AVERAGE THROUGH GAME:'.  The handicap rollover
  278.       will only take effect at the start of a week following the one where
  279.       this requirement is met.  I did this because ABC always seems refers
  280.       to this by game (eg- game 12) not week.
  281.  
  282.     - Items under the PERSONNEL menu column will no display without the
  283.       OUTOUT TO FILE being selected.
  284.  
  285.     - MENU CHANGES:  the PRINT ADDRESS option has been renamed PRINT LABELS.  
  286.                      This more accurately describes what it does.
  287.                      Only Bowlers with a address will be printed.
  288.  
  289.                      A new PRINT ADDRESS option has been created that prints
  290.                      each bowler's NAME, ADDRESS & PHONE one one line.
  291.  
  292.     - The ESC (escape) key does the same thing as the STOP gadget in the
  293.       Display window.
  294.  
  295.     - The ESC (escape) key will prompt you to stop a RUN on-the-fly.
  296.  
  297.     - The four cursor keys and shifted-cursor keys will move text in
  298.       the display window.  See the output help file for more details.
  299.  
  300.     - The display window now has it's own help text.
  301.  
  302.     - When you run the data the page numbers start at 1 now instead of 2.
  303.  
  304.     - Two part 'first' names are displayed properly in the
  305.       outputs that display the last name first.
  306.       Billy Bob Smith = Smith, Billy Bob
  307.  
  308.     - The Phone List, Address List and EOS report will not contain
  309.       any bowlers that names begin with a '#'.
  310.  
  311.     - The following items have been added to the League Editor Window:
  312.       - USE EA (Entering Average) THROUGH GAME: ___
  313.       - QUALIFY AFTER ___ GAMES
  314.       - RETROACTIVE HCP or NOT RETROACTIVE
  315.       Read the League Editor docs for more info.
  316.  
  317.     - To make room for the above additions you will have to check the
  318.       items checked in the menu as well as toggle gadgets in the
  319.       League editor window.  They will only have to be fixed once.
  320.  
  321.     - You may manually format the Social Security number now.  This is
  322.       helpful in the case of Canadian social security numbers that are 
  323.       grouped differently.  USA format:       000-00-0000
  324.                             Canadaian Format: 000-000-000
  325.       Any number with a hyphen in it will not be reformatted or marked
  326.       as an error regardless of what it contains or the length.
  327.  
  328. *** V0.7
  329.     - The Team High Scratch Game, High Scratch Series, High Handicap Game
  330.       and High Handicap Series scores should now be correct. 
  331.  
  332.     - The file requester received a face lift.  It now looks like the
  333.       rest of the program.
  334.  
  335.     - Form feeds are now part of the display.  They show up as a row
  336.       of number signs '######...' but dump as a form feed to file and
  337.       printer output.
  338.  
  339.     - You can not display more weeks than are in your season.  Until now you
  340.       could move through all 52 weeks even if your season only had 20.
  341.       If the weeks in season are not filled out all 52 weeks will still be
  342.       available.
  343.  
  344.     - The team's wins/loses/ties/forfeits may now be chosen by either
  345.       clicking with a mouse or using the function keys (F1-F5).
  346.       F1=Game1, F2=Game2, F3=Game3, F4=Game4 (if active), F5=Total_Pins
  347.       F6 will move you to the first bowler of the next team.
  348.  
  349.     - rewrote the memory magagement routines to keep them in one place
  350.       instead of mallocing all ofer the place.
  351.  
  352.     - Things yet to do/finish/consider...
  353.  
  354.         - I'm not happy with the league scheduler yet, whish should be obvious
  355.           if you try to use it.
  356.  
  357.         - The documentation isn't finished.
  358.  
  359.         - More & better error checking.  (I like yelling at users)
  360.  
  361. *** V0.6
  362.     - The league scheduler is beginning to do something.  Although it's
  363.       curently locked in the random mode.  NOTE: the schedule created
  364.       is not saved as part of the data, it is only saved as a text file.
  365.       This routine still needs plenty of work!
  366.  
  367.     - Fixed a number of loose bugs in the MOVE BOWLER TO SUB and the
  368.       MOVE SUB TO BOWLER routines.  Both of these routines will now
  369.       create a dummy bowler to give the team credit for games already
  370.       bowler.  These dummy bowlers will be called '#SCORE HOLDER x#' or
  371.       '#FILLER x#'.
  372.  
  373.     - Any bowler's name that is 'BLIND' or begins with a '#' will not
  374.       be displayed or printed out.
  375.  
  376.     - The program will stop the display of a RUN by clicking the 'S'
  377.       gadget in the display window.  (as should everything)
  378.  
  379.     - You will be prompted to save the data file after selecting 'QUIT'
  380.       unless the program is sure that there have been no changes.
  381.  
  382.     - Six hundred series now print.  This was just an oops!
  383.  
  384.     - Forfeitures don't mess up the bowler's pin count.
  385.  
  386.     - If you choose the WIN=2 option decimal places will be eliminated
  387.       from the WIN/LOSS area of the printout.
  388.  
  389.     - The phone list is now printed in two columns.
  390.  
  391.     - I've begin to add formfeeds to a few of the outputs.  If you see
  392.       a line of '#'s in the display they represent a page break.
  393.  
  394. *** V0.5
  395.     - Accepts substitutes now.  They may be entered by the 'USE SUB' gadget
  396.       or by entering the sub's position number directly.  eg- 'S1' for Sub 1
  397.       The selected sub MUST already have a score entered for the current
  398.       week and game to be accepted.  If you use the 'USE SUB' gadget only
  399.       games without any score will be substituted.
  400.  
  401.     - The selected sub's scores will be displayed for the current week in the
  402.       message area at the bottom of the Team Editor window.
  403.  
  404.     - The 'ABSENT' gadget also acts as a forced blind gadget.  The first
  405.       time that you press it games without scores will be 'A' (absent) the
  406.       second time they will change to 'B' (blind).  The 'A' or 'B' may be
  407.       entered from the keyboard also.  The Blind option will rarely be needed.
  408.  
  409.     - I'm VERY aware that some of the team numbers are not coming up
  410.       correctly.  I needed to get the Subs, Absent & Blind working before
  411.       I could work on them.
  412.  
  413.     - Assorted minor bugs were swatted and the code was cleaned up.   
  414.  
  415. *** V0.4
  416.     - Creates subdirectories from the League Info window (output path)
  417.  
  418.     - Doesn't re-write new icons for files that already have one.
  419.       This allows you to create custom icons and use snapshot without
  420.       a new icon clobbering your modifications each time.
  421.  
  422.     - Moved the RUN command to a submenu and added a PARTIAL RUN submenu.
  423.       The RUN command works the same as before.  PARTIAL RUN allows a
  424.       partial run (weeks 1-x) where 'x' is taken from the TEAM EDITOR's
  425.       current week gadget.
  426.  
  427.     - Totally re-wrote the season leaders routine.  It should be accurate
  428.       now and about 50% faster than before.
  429.  
  430.     - Added the version number in the screen's title bar
  431.  
  432.     - Swatted a few more bugs
  433.  
  434.     -System requesters now come up on the SS screen.
  435.  
  436.     This is still NOT intended for distribution.
  437.  
  438. *** V0.3
  439.     Many splattered bugs have been scrapped off of my moniter's glass.
  440.     Some functions are not finished, most notibly the league scheduler,
  441.     absent bowlers and substitutions.  I have begun to work on the numbers
  442.     that the program generates and there's plenty of work still needed.
  443.     Three of the four help screens are now mostly finished.
  444.     This was NOT intended for distribution.
  445.  
  446. *** V0.2
  447.     First upload to the WAVE*.  Many functions were buggy or not finished.
  448.     The purpose was just to hear some quick feedback on the front end.
  449.     I have not even begun working on the numbers that SS generates.
  450.     This was NOT intended for distribution.
  451.     *The WAVE is the BBS of the Suncoast Amiga User's Group.
  452.  
  453. *** V0.1
  454.     First attempt to get the parts to act as a whole.
  455.     This was never uploaded.  (wouldn't even arc without crashing  :-)  
  456.  
  457. Thanks, Allen.
  458. (GEnie - A.MARONEY)
  459.